ccmc::Kameleon Class Reference

TODO: Brief description of Kameleon class. More...

#include <ccmc/Kameleon.h>

Collaboration diagram for ccmc::Kameleon:

Public Member Functions
	Kameleon ()
virtual	~Kameleon ()
long	close ()
Interpolator *	createNewInterpolator ()
bool	doesAttributeExist (const std::string &attribute)
bool	doesVariableExist (const std::string &variable)
float	getConversionFactorToSI (const std::string &variable)
const std::string &	getCurrentFilename ()
Time	getCurrentTime ()
Attribute	getGlobalAttribute (long i)
Attribute	getGlobalAttribute (const std::string &attribute)
std::string	getGlobalAttributeName (long attribute_id)
std::vector< std::string >	getLoadedVariables ()
float	getMissingValue ()
const std::string &	getModelName ()
std::string	getNativeUnit (const std::string &variable)
int	getNumberOfGlobalAttributes ()
int	getNumberOfVariableAttributes ()
int	getNumberOfVariables ()
std::string	getSIUnit (const std::string &variable)
std::vector< float > *	getVariable (const std::string &variable)
Attribute	getVariableAttribute (const std::string &variable, const std::string &attribute)
std::string	getVariableAttributeName (long attribute_id)
const std::vector< float > *const	getVariableFromMap (const std::string &variable)
long	getVariableID (const std::string &variable)
std::vector< int > *	getVariableInt (const std::string &variable)
const std::vector< int > *const	getVariableIntFromMap (const std::string &variable)
std::string	getVariableName (long variable_id)
std::string	getVisUnit (const std::string &variable)
bool	loadVariable (const std::string &variable)
bool	loadVectorVariable (const std::string &variable)
long	open (const std::string &filename)
void	setMissingValue (float missingValue)
bool	unloadVariable (const std::string &variable)
bool	unloadVectorVariable (const std::string &variable)
int	getProgress ()

Static Public Member Functions
static int	_cxform (const char *from, const char *to, const double et, Position *v_in, Position *v_out)
static long	_cxRound (double doub)
static long	_date2es (int yyyy, int mm, int dd, int hh, int mm2, int ss)
static double	_gregorian_calendar_to_jd (int y, int m, int d, int h, int mi, int s)

Public Attributes
Model *	model

Detailed Description

TODO: Brief description of Kameleon class.

TODO: Full description of Kameleon class

Constructor & Destructor Documentation

Kameleon::Kameleon

(

)

Default constructor

Kameleon::~Kameleon ( )

virtual

Destructor

Member Function Documentation

int Kameleon::_cxform ( const char *  from, const char *  to, const double  et, Position *  v_in, Position *  v_out  )

static

Wrapper for the CXFORM function cxform(). Performs coordinate transformation from the source system to the target system at the specified time.

Parameters

from
to
et
v_in
v_out

Here is the call graph for this function:

long Kameleon::_cxRound ( double  doub )

static

Wrapper for the CXFORM function cxRound()

Parameters

doub

Here is the call graph for this function:

long Kameleon::_date2es ( int  yyyy, int  mm, int  dd, int  hh, int  mm2, int  ss  )

static

Wrapper for the CXFORM function date2es()

Parameters

yyyy
mm
dd
hh
mm2
ss

Here is the call graph for this function:

double Kameleon::_gregorian_calendar_to_jd ( int  y, int  m, int  d, int  h, int  mi, int  s  )

static

Parameters

y
m
d
h
mi
s

Here is the call graph for this function:

long Kameleon::close

(

)

Closes the currently opened file.

Interpolator * Kameleon::createNewInterpolator

(

)

Returns a new interpolater that maintains state information independent of other interpolators. This can be used to parallelize the interpolations.

Returns

A new interpolator.

bool Kameleon::doesAttributeExist

(

const std::string &

attribute

)

Parameters

attribute

Returns

bool Kameleon::doesVariableExist

(

const std::string &

variable

)

Parameters

variable

Returns

float Kameleon::getConversionFactorToSI

(

const std::string &

variable

)

Currently not implemented.

Parameters

variable

Returns

const std::string & Kameleon::getCurrentFilename

(

)

Returns

Time Kameleon::getCurrentTime

(

)

Calculates the current time based on the start time and the elapsed time.

Returns

Formatted string of the current time. This is currently different for different models. If the current time cannot be calculated, "TIME_UNAVAILABLE" is returned.

Here is the call graph for this function:

Attribute Kameleon::getGlobalAttribute

(

long

i

)

Parameters

i

Returns

Attribute Kameleon::getGlobalAttribute

(

const std::string &

attribute

)

Parameters

attribute

Returns

std::string Kameleon::getGlobalAttributeName

(

long

attribute_id

)

Parameters

attribute_id

Returns

std::vector< std::string > Kameleon::getLoadedVariables

(

)

Returns

float Kameleon::getMissingValue

(

)

Returns

const std::string & Kameleon::getModelName

(

)

Returns the model name of the opened file.

Returns

The model name.

std::string Kameleon::getNativeUnit

(

const std::string &

variable

)

Returns the units of the variable specified. The units may differ from the units in the original data.

Parameters

variable

Returns

String representation of the units

int Kameleon::getNumberOfGlobalAttributes

(

)

Returns

int Kameleon::getNumberOfVariableAttributes

(

)

Returns

int Kameleon::getNumberOfVariables

(

)

Returns

int Kameleon::getProgress

(

)

std::string Kameleon::getSIUnit

(

const std::string &

variable

)

Parameters

variable

Returns

std::vector< float > * Kameleon::getVariable

(

const std::string &

variable

)

Attribute Kameleon::getVariableAttribute	(	const std::string &	variable,
		const std::string &	attribute
	)

Parameters

variable
attribute

Returns

std::string Kameleon::getVariableAttributeName

(

long

attribute_id

)

Returns

const std::vector< float > *const Kameleon::getVariableFromMap

(

const std::string &

variable

)

Returns a pointer to the variable data stored in a map. This method works for variables of type float. This cannot and should not be modified or deleted. Use loadVariable and unloadVariable to manange the map.

Parameters

variable

Returns

long Kameleon::getVariableID

(

const std::string &

variable

)

Parameters

variable

Returns

std::vector< int > * Kameleon::getVariableInt

(

const std::string &

variable

)

Parameters

variable

Returns

const std::vector< int > *const Kameleon::getVariableIntFromMap

(

const std::string &

variable

)

Returns a pointer to the variable data stored in a map. This method works for variables of type int. This cannot and should not be modified or deleted. Use loadVariable and unloadVariable to manange the map.

Parameters

variable

Returns

std::string Kameleon::getVariableName

(

long

variable_id

)

Parameters

variable_id

Returns

std::string Kameleon::getVisUnit

(

const std::string &

variable

)

Parameters

variable

Returns

bool Kameleon::loadVariable

(

const std::string &

variable

)

Parameters

variable

Returns

bool Kameleon::loadVectorVariable

(

const std::string &

variable

)

Parameters

variable

Returns

long Kameleon::open

(

const std::string &

filename

)

Parameters

filename

Returns

Here is the call graph for this function:

void Kameleon::setMissingValue

(

float

missingValue

)

Returns

bool Kameleon::unloadVariable

(

const std::string &

variable

)

Parameters

variable

Returns

bool Kameleon::unloadVectorVariable

(

const std::string &

variable

)

Parameters

variable

Returns

Member Data Documentation

Model* ccmc::Kameleon::model

---

The documentation for this class was generated from the following files:

• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Kameleon.h
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Kameleon.cpp
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Kameleon_initializeListOfRequiredVariablesForComponentsAndVectors.cpp
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Kameleon_initializeUnits.cpp
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Kameleon_initializeVariableAliases.cpp
• /Users/apembrok/Documents/workspaces/workspace.bak2/workspace.backup/kameleon-plus/src/ccmc/Kameleon_open.cpp